Release 10.1A: OpenEdge Development:
Progress Dynamics Advanced Development

Logic

The client logic API supports code written in the following locations:

Static object code.
Custom super procedure logic associated with containers, browses, and viewers.

For dynamic objects, while you can use the API in any function or internal procedure of the custom super procedure, the following are usually the best places to put client logic code:

rowDisplay internal procedures.
Widget event procedures.
ADM override procedures and functions.
Note: You cannot use the client logic API in the main block of the custom super procedure.

rowDisplay internal procedures

For your custom super procedures, take advantage of this procedure and place appropriate client logic code inside. This technique is parallel to the validation procedures of the SDO, in that it provides a hook where you can put code and benefit from the supplied standard behavior.

Unless noted in the description of the function, the API only supports actions within a browse rowDisplay internal procedure that are supported by the 4GL for the browse ROW-DISPLAY event.

Widget event procedures

The standard name for UI event procedures is <widget><event>. For example, CreditLimitLeave, indicates ON LEAVE OF CreditLimit.

The Migration utility converts existing embedded trigger code blocks into super procedure internal procedures with this naming convention, so this is the recommended standard for new UI event procedures (the event action).

Note that you must first define your own UI events using the dynamic property sheet.

ADM overrides

Use the API in ADM overrides as you would use any of the APIs described in the ADM documentation. See the ADM documentation for more information about overrides.

Error handling

The client API does not raise errors, since errors at the client level are not desirable. If Progress Dynamics cannot locate a referenced object, or if t does not support the specified operation, then the function returns FALSE or unknown if the function has a character or handle return. Progress Dynamics raises no other visible error condition.

TARGET-PROCEDURE

When using the client API from a super procedure, always remember to invoke internal procedures and functions IN TARGET-PROCEDURE from a super procedure.